KFbxIO Class Reference

#include <kfbxio.h>
Inheritance diagram for KFbxIO:
Inheritance graph
[legend]

List of all members.


Detailed Description

Base class for FBX file importer and exporter.

Definition at line 57 of file kfbxio.h.


Error Management

enum   EError {
   eFILE_CORRUPTED,
   eFILE_VERSION_NOT_SUPPORTED_YET,
   eFILE_VERSION_NOT_SUPPORTED_ANYMORE,
   eFILE_NOT_OPENED,
   eFILE_NOT_CREATED,
   eOUT_OF_DISK_SPACE,
   eUNINITIALIZED_FILENAME,
   eUNIDENTIFIED_ERROR,
   eINDEX_OUT_OF_RANGE,
   ePASSWORD_ERROR,
   eEMBEDDED_OUT_OF_SPACE,
   eERROR_COUNT
}
  Error identifiers. More...
KError GetError ()
  Retrieves the error object.
EError  GetLastErrorID () const
  Returns the last error code.
const char *  GetLastErrorString () const
  Returns the last error string.
void  GetMessage (KString &pMessage) const
  Returns the warning message from the file Reader and Writer.

Public Member Functions

virtual bool  Initialize (const char *pFileName)
  Initializes the object.
virtual KString  GetFileName ()
  Returns the file name.

Member Enumeration Documentation

enum EError

Error identifiers.

  • eFILE_CORRUPTED
  • eFILE_VERSION_NOT_SUPPORTED_YET
  • eFILE_VERSION_NOT_SUPPORTED_ANYMORE
  • eFILE_NOT_OPENED
  • eFILE_NOT_CREATED
  • eOUT_OF_DISK_SPACE
  • eUNINITIALIZED_FILENAME
  • eUNIDENTIFIED_ERROR
  • eINDEX_OUT_OF_RANGE
  • ePASSWORD_ERROR
  • eEMBEDDED_OUT_OF_SPACE
Enumerator:
eFILE_CORRUPTED 
eFILE_VERSION_NOT_SUPPORTED_YET 
eFILE_VERSION_NOT_SUPPORTED_ANYMORE 
eFILE_NOT_OPENED 
eFILE_NOT_CREATED 
eOUT_OF_DISK_SPACE 
eUNINITIALIZED_FILENAME 
eUNIDENTIFIED_ERROR 
eINDEX_OUT_OF_RANGE 
ePASSWORD_ERROR 
eEMBEDDED_OUT_OF_SPACE 
eERROR_COUNT 

Definition at line 97 of file kfbxio.h.


Member Function Documentation

virtual bool Initialize ( const char *  pFileName  )  [virtual]

Initializes the object.

Parameters:
pFileName  The name of the file to access.
Returns:
True if successful, returns false otherwise.
Remarks:
To identify the error, call KFbxIO::GetLastErrorID().

virtual KString GetFileName (  )  [virtual]

Returns the file name.

Returns:
The file name or an empty string if no filename has been set.

KError& GetError (  ) 

Retrieves the error object.

Returns:
A reference to the error object.

EError GetLastErrorID (  )  const

Returns the last error code.

Returns:
The last error code.

const char* GetLastErrorString (  )  const

Returns the last error string.

Returns:
A textual description of the last error.

void GetMessage ( KString pMessage  )  const

Returns the warning message from the file Reader and Writer.

Parameters:
pMessage  The warning message.
KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO
KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO KFbxIO